Skip to content
This repository was archived by the owner on May 10, 2021. It is now read-only.

update README to explain the future of next on netlify #114

Merged
merged 2 commits into from
Dec 13, 2020
Merged

update README to explain the future of next on netlify #114

merged 2 commits into from
Dec 13, 2020

Conversation

lindsaylevine
Copy link
Contributor

No description provided.

@lindsaylevine lindsaylevine added the type: chore work needed to keep the product and development running smoothly label Dec 13, 2020
@lindsaylevine lindsaylevine mentioned this pull request Dec 13, 2020
Closed
@lindsaylevine lindsaylevine force-pushed the ll/readme-plugin-explanation branch from 367be0d to 218f140 Compare December 13, 2020 14:42
sdras
sdras suggested changes Dec 13, 2020
View reviewed changes
Copy link
Contributor

@sdras sdras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just a few small changes here.

README.md Outdated

The plugin can be found on [npm here](https://www.npmjs.com/package/@netlify/plugin-nextjs).

## About

`next-on-netlify` is a utility for enabling server-side rendering in Next.js on Netlify. It wraps your application in a tiny compatibility layer, so that pages can use Netlify Functions to be server-side rendered.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still need to be at the top- people need to know what they're looking at with a sentence or two before anything else.

We also two links in bullets right after this sentence before moving on:

  • build plugin link
  • npm package

README.md Outdated
@@ -15,6 +15,22 @@
</a>
</p>

## The Future of Next.js on Netlify
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer wording like "Next on Netlify Roadmap" here.

sdras
sdras approved these changes Dec 13, 2020
View reviewed changes
Copy link
Contributor

@sdras sdras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@lindsaylevine lindsaylevine merged commit 18a7082 into main Dec 13, 2020
@lindsaylevine lindsaylevine deleted the ll/readme-plugin-explanation branch December 13, 2020 16:57
@ChrisBAshton
Copy link

Hi 👋 the future looks exciting!

But I think we could do with highlighting that @netlify/plugin-nextjs is not yet ready for use with Netlify CLI. I just tried migrating from one to the other before I read the note tucked away in the caveats section! It looks as though next-on-netlify is still the recommended approach if you're using the CLI.

@lindsaylevine
Copy link
Contributor Author

@ChrisBAshton hey chris! thanks so much for calling this out, i agree this was an oversight. my thoughts at the moment:

  1. this is the real issue using the plugin with the CLI, for full transparency. basically, re-runs of netlify build or netlify deploy --build will fail if you don't get rid of the functions and publish dirs that the plugin generates. reason: we took out the "clean directory" logic for the plugin to support custom functions, but of course, that created the pain points laid out in that issue. all that said, it is possible to use the CLI with the plugin; it just means you have to do the manual clean yourself at the moment. just sayin'

  2. that said, since this was a reason for you to not switch, i'm going to prioritize a fix for it. i'll tag you on the issue (and then the PR/release) to keep you updated.

thank you again!!!!!!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sdras sdras sdras approved these changes

@cassidoo cassidoo Awaiting requested review from cassidoo

@FinnWoelm FinnWoelm Awaiting requested review from FinnWoelm

Assignees
No one assigned
Labels
type: chore work needed to keep the product and development running smoothly
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lindsaylevine @ChrisBAshton @sdras